What follows is my attempt at an English translation of the Edit7 documentation "Edit 7 Read Me" that is included in the Edit7 1.0b2 package. Unfortunately to many of the people in the world, that documentation is written in Japanese. So, encouraged by a request from Harry Hahn (hhahn@macc.wisc.edu), who is the author of the Text Editor mini-FAQ, I (Mark Nagata) have translated the documentation into English. Since it's a quick translation job in a hurry, there might well be translation errors in this document. I apologize in advance for any such possible errors.
I have permission from the author, Mr. Hideaki Iimori, for uploading this translation to the Internet archive sites. With giving me that permission, he asked me to add his comments (remember, the original documentation was written in October 1993) as follows:
** The publicly distributed version 1.0b2 is a "rather old version", and he is currently working on a version that looks rather different from 1.0b2, and thus it would be nearly impossible for him to support the 1.0b2 version now, or to actively respond to questions/requests for 1.0b2.
** He would appreciate it if the English translation would say that the author would prefer the address qfh00053@niftyserve.or.jp rather than the compuserve address (which is listed in the application's 'About' box).
Mark Nagata (nagata@kurims.kyoto-u.ac.jp)
Translator of this documentation
--- Now begins the translation of 'Edit 7 Read Me', dated October 1993. ---
What is Edit7 ?
Edit7 is a Multilingual Text Editor that handles plain text files.
The goal of Edit7
* Create a software that is usable world-wide, taking full advantage of the Script Manager (WorldScript I/II).
* Experiment/practice an object-oriented architecture/programming/operation.
* Apply the essential functions of System 7, like AppleScript.
Features of Edit7
* Line wrap display ON/OFF
* TAB/CR/EOF marks display ON/OFF
* Horizontal scroll bar display ON/OFF
* Line number display ON/OFF
* Auto indent ON/OFF
* Variable high-speed scrolling
* High-speed Japanese in-line input, with the help of Inline++ (Under System 7.1, the in-line input is possible under the Japanese/Korean/Chinese Script Systems, if 'Inline++TSM' Extension is running.
* Auto-saves window location, font settings, etc.
* Supports the Script Manager (WorldScript I/II). At this moment, it fully supports Scripts that write left-to-right. Usable under all Scripts except Arabic/Hebrew, etc.
* Uses System 7 temporary memory, that effectively uses the available RAM without modifying the application's memory allocation. (System 7 only).
* Supports its own virtual memory. When the actual RAM size is not sufficient, Edit7 uses the hard disk to continue editing large files.
* All operations that modify text are undoable.
* Practically unlimited multiple Undo.
* Supports file-paste, and file-save for the selected region.
* Supports Drag & Drop text editing (can drag & drop between document windows).
* Document windows are splittable an unlimited number of times.
* An unlimited number of View windows can be created for a single document.
* Supports International Grep (the internationalized Grep that uses the Script Manager).
* File Search function can search by file name pattern, file creation date and file modification date, etc.
* Can start search by drag & drop file/folder/disk icons in the Finder. Recognize aliases (System 7 only).
* Batch Search documents or files.
* Supports System 7 Stationery files.
* Supports Userland Frontier's Menu Sharing Protocol.
Restrictions
* Can run on all Macintoshes that run System Software 6.0.7 or later.
* Handles plain text files only (file type 'TEXT').
* Since it is an application that handles plain text files, only one Font can be used in each document window.
* One line of text can contain no more than 32,767 bytes.
* The maximum size of file that can be edited is about 60 megabytes plus the available RAM, assuming that there is enough free space on the hard disk.
Features that are not yet supported
* Formatted Printing. The 'Print Preference' dialog is not operational.
* Reverse Search.
* Replace All
Features that are planned to be implemented in the future
* More powerful editing features, key binding customization
* Support of AppleScript
* Mark support
* Plug-in tools
* More Grep features (currently, "|" and "\1" are not yet supported.)
* Support of right-to-left Script Systems.
Warning
This is a development version! Please keep that in mind.
Just copy the application file to your hard disk, and you can run it there. I don't expect any bugs that could cause a System Error, but I have left some Debugger symbols in the application, and so I would appreciate it if you could report a Macsbug or TMON report that lists disassemble near PC, stack crawl, registers and heap dump, in case Edit7 dropped into the debugger on your machine.
Operation of Edit7
Since it is a version still under development, the features/operation might change in the future, but here I will list some explanation on the operation of version 1.0b2.
File Menu
New Creates a new document window.
Open... Opens a text file.
Close Closes the frontmost window.
Save Saves the content of a document window.
Save As... Saves the content of a document window/find result window into a new file.
Revert to Saved Puts back the content of the document window to the content you have last saved.
Paste File... Pastes a file's content onto the current selection range (undoable).
Save Selection As... Saves the current selection range into a new document.
Preferences
Edit... Editing-related settings.
File Search... File Search-related settings.
Print... Printing-related settings.
Page Setup... Sets the page setup for the printer.
Print... Prints the content of the document window/find result window. Currently no print formatting is supported yet. (plain text only)
Quit Quits the application.
File Menu -related Windows
Edit Preference Dialog
Max VM Size/Doc Sets the maximum virtual memory size per one document.
Max Scroll Speed Sets the maximum scroll speed for document windows.
Max Zoom Width Sets the maximum window width with window Zoom.
Max No. of Undos Sets the maximum level of Undos.
Auto Save Window Position If checked, auto-remembers the document window location and the Format menu settings.
Update Clipboard When Drag Text If checked, the Clipboard content is updated when you do drag & drop text editing.
Sync Font and KeyScript If checked, automatically switches the KeyScript corresponding to the Font that the frontmost document window uses.
File Search Preferences Dialog
Drag & Drop Search Trigger Key When you drag & drop a file/folder/disk icon onto Edit7's icon in the Finder, with the modifier key that is set here, Edit7 will automatically start File Search. (System 7 only).
Folder Search Depth Sets the maximum level of subfolders the File Search should look into a folder/disk. When it is set to "1", only the files that are directly inside the target folder are searched.
Print Preferences Dialog
Not yet working. Does not do anything, whatever you set in here.
Edit Menu
Undo xxxx nn/mm Undoes the last operation on text.
xxxx: the name of the operation
nn: the current location in the document
mm: the number of levels of Undos that are currently kept for the document
Redo xxxx nn/mm Redoes the last Undoed operation.
xxxx: the name of the operation
nn: the current location in the document
mm: the number of levels of Undos that are currently kept for the document
Clear Undos... nn/mm Clears all the Undo history. Effective when you are short of memory size.
nn: the number of levels of Undos that are currently kept
mm: the maximum number of Undos
Cut Delete the selected range of text and send it to the Clipboard. (undoable)
Copy Send the selected range in the document window to the Clipboard. Also sends the selected lines in the Find Result window to the Clipboard.
Paste Replace the selected range of text with the Clipboard content. (undoable)
Clear Delete the selected range of text. (undoable)
Select All Select all content of the document window/Find Result window.
Show Clipboard Displays the Clipboard content.
Edit Menu -related Window
Clipboard Window
Displays the Clipboard content, when you select the 'Show Clipboard' menu. Display Format setting is available in the same way as in a document window. Format settings, ON/OFF state, window location for the Clipboard Window is always automatically remembered.
Search Menu
Find... Display the Find/Replace Dialog.
Find Again Repeat the search for the current find string.
Find Selection Search for the currently selected text string.
Enter Selection Make the currently selected text string the find string.
Replace Replace the currently selected text string with the replace string.
Replace All Not implemented yet.
Select Search Folder... Set the target folder for the File Search. It is mainly meant for System 6 users. Under System 7, I would recommend drag & drop operation in the Finder.
File Filter... Displays the File Filter Dialog.
Show Find Results Displays the Find Results Window.
Go To Line... Moves the document window's display location to the specified line.
Search Menu -related Windows
Find/Replace Dialog
Settings, ON/OFF state, window location for the Find/Replace Window is always automatically remembered. The Font used in the Find/Replace dialog is automatically changed into the currently frontmost document window's Font/Script settings. When there is no document window open, you can set the Font settings for the Find/Replace dialog.
Find Next Search for the next occurrence of the find string.
Reverse Not implemented yet.
Replace & Find Replace the current selection with the replace string and search for the next occurrence of the find string. (undoable)
Replace Replace the current selection with the replace string. (undoable)
Replace All Not implemented yet.
Ignore Case When checked, uppercase/lowercase letters are not distinguished.
Ignore 1Byte/2Byte When checked, the 1-byte code and the 2-byte code for an alphabetical/numerical/Kana/symbol are not distinguished. (meaningful under the Japanese Script only)
Grep When checked, use the International Grep function. Supports 2-byte Scripts in Japanese/Korean/Chinese, too.
Regular Expressions that are currently supported:
^ matches the start of a line
$ matches the end of a line
. matches any character that is not CR (carriage return). Under appropriate document Script, a 2-byte code is recognized as a character.
[characterset ] matches any character in the characterset. Under appropriate document Script, a 2-byte code is recognized as a character. Example: [a-zA-Z], [0-9]
[^characterset ] matches any character that is not in the characterset. Under appropriate document Script, a 2-byte code is recognized as a character. Example: [^a-zA-Z], [^0-9]
pattern * repetition of zero or more times of the pattern. Example: [0-9]*, A*
pattern + repetition of one or more times of the pattern. Example: [0-9]+, A+
pattern ? repetition of zero or one time of the pattern. Example: texts?
\xHH matches the 1-byte character for the ASCII byte 0xHH. Example: \x0d : CR code
\xHHHH matches the 2-byte character for the ASCII 2-byte 0xHHHH. Example: \x8140 : Shift-JIS space code
\t TAB code
\n Line Feed code
\r CR code
\specialChar treats the characters that have special meanings in Regular Expression as normal characters. Example: \. : means the period character, not any single character.
Wrap Around When checked, continues the search from the beginning of the file after the search reaches the end of the file. (Applicable only when Batch Find is OFF.)
Batch Find When checked, uses the Batch Find mode.
Match Once in 1 Line Recognizes only one occurrence per one line of text. (Applicable only when Batch Find is ON.) Normally, I would recommend you to keep this checked, because an enormous numbers of matches might occur when a pattern is used that matches any characters.
Select Search Folder Dialog
The standard file selection dialog appears when you select the 'Select Search Folder...' menu. The target folder for the File Search can be selected there, either by pressing the 'Select "foldername"' button, or by selecting any TEXT file inside the folder you want to be the target folder.
File Filter Dialog
Sets the condition for files to be searched. When multiple conditions are set, then only those files that satisfy all of the conditions are searched. Settings, ON/OFF state, window location for the File Filter Window is always automatically remembered.
File Name When checked, restrict the target to those files that matches the filename pattern. When 'Grep' is not checked, any partial match is considered as a match. When 'Grep' is checked, the full match is required.
Ignore Case When checked, uppercase/lowercase letters are not distinguished.
Ignore 1Byte/2Byte When checked, the 1-byte code and the 2-byte code for an alphabetical/numerical/Kana/symbol are not distinguished. (meaningful only when the System's primary Script is Japanese)
Grep When checked, use the International Grep function. The Grep pattern is interpreted in the context of the System's primary Script.
Edit7 Files Only When checked, only files that are created by Edit7 are looked at. When unchecked, all TEXT files are looked at.
Create Date Restrict the search be the file creation dates.
Modify Date Restrict the search be the file modification dates.
= on that day only
< on that date or earlier
> on that date or later
! all dates other than that date
Find Results Window
When you run a Batch Find from the Find/Replace dialog, a Batch Search is done for the frontmost document window, and then the Find Results Window will display the matched lines.
The display format is:
Document name <TAB> line number <TAB> content of the line.
The mouse pointer will change over the Find/Replace Window. If you double-click on a line, the line will be displayed in the document window.
The content of the Find Results Window can be saved in a TEXT file, if you select 'Save As...' from the 'File' menu. You can select one or more lines (shift-click, command-click, 'Select All' are available). You can use the 'Copy' item from the 'Edit' menu, to copy the contents to the Clipboard.
You can select the Font to be used in the Find Results window, by the 'Format' menu. Font settings, ON/OFF state, window location for the Find Results Window is always automatically remembered.
Go To Line Dialog
Jumps to the specified line.
Format Menu
The settings of the Format menu are automatically remembered in each document file's resources.
Wrap Line toggle the wrap display of lines.
TAB/CR/EOF toggle the display of TAB/CR/EOF codes.
Horiz Scroll Bar toggle the display of the horizontal scroll bar.
Line No. toggle the display of the line numbers.
Auto Indent toggle Auto Indent.
TAB Width... set the TAB width.
Line Prefix... set the Line Prefix string.
Font set the display font. [Be warned -- a Font corresponds to a Script. If you switch to a Font with different Script, the context will change, regarding the definition of a character, selection with double-clicking, Grep search pattern interpretation, etc. This is all due to the fundamental relation between Font and Script in the Macintosh Script System.]
Size set the display Font Size.
Capture Defaults set the current Format menu settings to the default setting for a new document.
Format Menu -related Windows
TAB Width Dialog
Sets the TAB width.
Line Prefix Dialog
Sets the Line Prefix text string. TAB or "//" can be used for programming source files, and "> " is recommended for communication logs. The string is used in the 'Add Prefix'/'Remove Prefix' command in the 'Tools' menu.
Window Menu
Split 2 Split the frontmost document window into two.
New View Create a new View window for the frontmost document window.
Send Back Moves the frontmost document window to the rearmost.
Toggle Front 2 Switches the frontmost two document windows.
Stack Clean up the arrangement of all the document windows.
Tile Tile all the document windows.
Tile 2 Vertical Tile two frontmost document windows vertically.
Tile 2 Horizontal Tile two frontmost document windows horizontally.
Tile 3 Vertical Tile three frontmost document windows vertically.
Tile 3 Horizontal Tile three frontmost document windows horizontally.
A list of currently open documents are appended at the bottom of the 'Window' menu. Command-1 to command-9 shortcuts are assigned for the first nine items.
If you select an item from this document list, then the frontmost window among the open Views for that document is brought to the front.
If the selected document happens to be already frontmost, then, all of the Views for that document will be brought to the front, over all other documents.
Tools Menu
Format Lines Wrap the selected range of text, removing and adding the CR code, so that it will fill the current window width, and the lines are ended with carriage return characters. (undoable)
Format Lines with Prefix Do Format Lines with each line prefixed by the Line Prefix string. (undoable)
Remove CR Connect lines in the selected range and make it a single line.
Add Prefix Add the Line Prefix string to each of the lines in the selected range. (undoable)
Remove Prefix Delete the Line Prefix string from each of the lines in the selected range. (undoable)
TAB -> Spaces Replace TABs with spaces. (undoable)
Spaces -> TAB Replace spaces with TABs. (undoable)
Show Edit7 on Finder Select (Reveal) the Edit7 application icon in the Finder. (System 7 only)
Show File on Finder Select (Reveal) the file icon for the current document file or for the currently selected line in the FInd Results window in the Finder. (System 7 only)
Find in THINK Reference Lookup THINK Reference for the currently selected text string. (System 7 only, requires THINK Reference)
Frontier Menu
Appears (next to the 'Tools' menu) when UserLand Frontier (UserLand Software, Inc.) is running. Edit7 supports UserLand Frontier's Menu Sharing Protocol. An experimental Install File is attached, so please try it if you can. A few Object Models and Core Suites for AppleScript support are implemented now.
Working on a Document Window
The window title is shown as "<Document name> :View <View number>". When a non-saved change is made to the document, a "*" is added on top of the title.
If you do window Zooming/Tiling on a multiple monitor setup, then the Zooming/Tiling is done only on the monitor where the mouse cursor is.
If you click the scroll bar with the option key down, then the scroll goes in the reverse direction.
Double-click selects a word.
Triple-click selects a line.
Quadraple-click selects the whole document.
Dragging after double/triple clicking without releasing the mouse button, then the selection range will enlarge with the corresponding units.
The arrow keys will move the caret by a character (according to the current Script).
Option-left/right arrowkey will move the caret over a word.
Control-left/right arrowkey will move the caret to the beginning/end of line.
Option-up/down arrowkey will move the caret to the beginning/end of the document.
Shift-combination of any of the above will enlarge the selection.
Splitting a Document Window
Dragging the Splitter region above the vertical scrollbar will split the window at any location. Move the mouse onto the Splitter region (the black area), and the cursor changes:
Drag it to slide it to the location you want:
And release the mouse button:
You can change the splitting location by dragging the split bar at any time.
By repeating the procedure, you can get any number of multiple splitting:
If you want to clear the splitting, you can drag the split bar over the next one, or you can double-click on the split bar to erase it.
Multiple Views of a Document
Selecting the 'New View' item from the 'File' menu will duplicate the current document window, by creating a new View window. Just like the window splitting, you can create an unlimited number of Views from a document. It would be convenient if you want to edit various locations of a document.
Unlike split window, multiple Views are more flexible, in that each View can have different window location, window size and various Format settings. Play with it, and find your own usage of the multiple View.
Drag & Drop Text Editing
In addition to the traditional Cut, Copy, Paste, Edit7 will allow you text editing by Drag & Drop. When you move the mouse pointer over the selected range of text, the cursor changes to a hand (Grab Cursor):
Press the mouse button, and "grab" the selected text:
Keep grabbing the text and move out of the selected region, and the cursor changes to the Move Drop Cursor:
Release the mouse button at the target location, and the text has moved:
If you also press the Option Key with grabbing text, then the mouse cursor will be a different Drop Cursor. In this case, the original text is kept, and you will be making a copy of the text. You can temporarily change the Move Drop Cursor to the Drop Cursor, by pressing the Option Key.
Text move/copy by Drag & Drop is not limited to a single window. You can drag it between split windows, other Views or even between different document windows.
If you move outside of all the windows while dragging, then the cursor will change to the Trash Cursor. If you release the mouse button while the cursor is the Trash Cursor, then you will be trashing the text. It is equivalent to the 'Clear' command.
If you press down the Shift Key while you drag text out of a window, then, the cursor will not change to the Trash Cursor; Instead, the window will Auto-Scroll.
Also, the cursor will change to the Clipboard Cursor if you move the mouse pointer over the Clipboard Window. If you release the mouse button there, then you have move/copied the text to the Clipboard. It is equivalent to the 'Cut'/'Copy' commands.
All Drag & Drop operations on the text are undoable.
File Search Features
If you either (1) select 'Select Search Folder...' from the 'Search' menu and select a target folder, or (2) drag & drop a file/folder/disk icon over the Edit7 icon, in the Finder (under System 7), with the Trigger Key (that is set by the File Search Preferences dialog, the default is the Control Key) pressed, then a File Search is started, for the current find string that is set in the Find/Replace dialog.
While the File Search is in progress, the following File Search Control Window is displayed, and you can see the progress, and also control the search, from there:
If 'Batch Find' is set to OFF in the Find/Replace dialog, then the search stops when the first match is found, the file is opened and the match is displayed.
If 'Batch Find' is set to ON, then the Find Results Window is displayed. Just like in the Find Results Window for a Search over a document window, Find Results Window allows you to double-click on a line to let it open the file and display the match.
If you select 'Show File on Finder' from the 'Tools' menu with the match line(s) is selected, then the corresponding file is highlighted in the Finder. (System 7 only).
You can switch to another application while Edit7 is doing the File Search in the background.
Edit7 recognizes System 7 aliases, and so it would be a good idea to keep aliases of frequently-used files/folders in a convenient folder, and you can drop that folder onto Edit7 with the Control Key down, to run the search for all the files.
Upon File Search, Edit7 will use the Font/Script specified in the file's resources, if the file is a Edit7 file. If the TEXT file was not created by Edit7, then the System's primary Script is used.
Tips
When you see the HardDisk Cursor while Edit7 is doing some operation, that means that Edit7 is using its Virtual Memory features because the actual memory is short. The data is being swapped between RAM and the hard disk. There will be no problem if you have enough hard disk space, but the speed of the operation will definitely slow down.
Quit other applications to increase the available RAM (System 7)
to allow as much things to be done within memory.
The display speed will noticeably slow down if you set the display of LineNumbers/TAB/CR/EOF to ON. If you want the maximum speed display behavior, I would recommend you to set LineNumbers/TAB/CR/EOF display OFF, and set the Monitor to 1-bit black-and-white. Under this situation, I believe that Edit7 realizes the fastest speed among the currently available Macintosh text editors.
Edit7 supports System 7 Stationery features. You can Save a document with your favorite Format settings, window location and document template, use Finder's Get Info command to check the file's 'Stationery pad' checkbox. After that, you can just double-click this Stationery to create a new document window in Edit7.
Version History
1.0b2 10/31/1993
* Use only MC68000 instructions
* Added Auto Indent
* 'Format Lines with Prefix' added into the 'Tools' menu
* 'Sync Font and KeyScript' added into Edit Preference
* Changed the application/document icons
* Support of Thunder7's Glossary feature
* Corrected window updating after Find & Replace
* Leave 3 lines worth of space at the bottom of the window, to accommodate the in-line transformation region
* Fixed a bug that would cause a System Error after Printing, with some printer drivers
* Corrected the System version check to allow "6.0.6", because the Japanese KanjiTalk 6.0.7 system incorrectly specifies itself as "6.0.6"
* Corrected behavior of duplicate move with drag & drop text
* Set the insertion point to the end of the region after drag & drop text
* Implemented the Preferences file
* Fixed a bug that would cause an "a required resource is missing" error, with combination of a certain printer drivers and some Extensions
* Allowed the Font change in the Find/Replace dialog while no document window is open, to enable a File Search with Scripts other than the Primary Script
* Corrected the line wrap method with entering a space in the middle of a word
* Corrected the 'Close' behavior when the Find Results Window is the only window
* Some English spelling errors
1.0b1 10/1/1993
* The first public version
Finally,
(1) This software is freeware. You can download it from network services, or you can freely give a copy to your friends. No charge is required for using this software.
(2) The copyright for this software belongs to the author.
(3) The author is not liable to any damage caused by this software.
(4) No redistribution of any modified archive is allowed.
(5) Charged distribution of this software for profit, by any commercial company or individual, is not allowed.
(6) If a company or an individual would want to distribute this software, with or without charge, for the purpose of sales promotion or attraction, then an advance permission by the author is required. Uploading this software to a commercial network services library, is excluded from this restriction.
(7) The author keeps the right to demand the recovery of all of the distributed copies, in the event this software were distributed against the terms (5) or (6).
(8) If you have bug reports, requests, questions, etc., please post your message to the Mac Programming forum FMACPRO of the NiftyServe BBS. Alternatively, you can send email to:
